Spot-On
spot-on-kernel.h
1 /*
2 ** Copyright (c) 2011 - 10^10^10, Alexis Megas.
3 ** All rights reserved.
4 **
5 ** Redistribution and use in source and binary forms, with or without
6 ** modification, are permitted provided that the following conditions
7 ** are met:
8 ** 1. Redistributions of source code must retain the above copyright
9 ** notice, this list of conditions and the following disclaimer.
10 ** 2. Redistributions in binary form must reproduce the above copyright
11 ** notice, this list of conditions and the following disclaimer in the
12 ** documentation and/or other materials provided with the distribution.
13 ** 3. The name of the author may not be used to endorse or promote products
14 ** derived from Spot-On without specific prior written permission.
15 **
16 ** SPOT-ON IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 ** IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 ** OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 ** IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 ** INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 ** NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 ** SPOT-ON, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 
28 #ifndef _spoton_kernel_h_
29 #define _spoton_kernel_h_
30 
31 extern "C"
32 {
33 #include <curl/curl.h>
34 }
35 
36 #include <QAtomicInt>
37 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
38 #include <QBluetoothAddress>
39 #endif
40 #include <QDateTime>
41 #include <QFileSystemWatcher>
42 #include <QFuture>
43 #include <QHash>
44 #include <QHostAddress>
45 #include <QMultiMap>
46 #include <QPointer>
47 #include <QQueue>
48 #include <QReadWriteLock>
49 #include <QSqlDatabase>
50 #include <QTimer>
51 #if QT_VERSION >= 0x050000
52 #include <QtConcurrent>
53 #endif
54 #include <QtCore>
55 
56 #include "Common/spot-on-common.h"
57 #include "Common/spot-on-send.h"
58 
59 class spoton_crypt;
60 class spoton_fireshare;
61 class spoton_gui_server;
62 class spoton_listener;
63 class spoton_mailer;
64 class spoton_neighbor;
68 
69 class spoton_kernel: public QObject
70 {
71  Q_OBJECT
72 
73  public:
74  spoton_kernel(void);
75  ~spoton_kernel();
76  static QAtomicInt s_congestion_control_secondary_storage;
77  static QAtomicInt s_sendInitialStatus;
78  static QHash<QString, spoton_crypt *> s_crypts;
79  static QList<QPair<QByteArray, QByteArray> > s_adaptiveEchoPairs;
80  static QMultiHash<qint64, QPointer<spoton_neighbor> > s_connectionCounts;
81  static QList<QByteArray> findBuzzKey(const QByteArray &data,
82  const QByteArray &hash);
83  static QList<QByteArray> findInstitutionKey(const QByteArray &data,
84  const QByteArray &hash);
85  static QList<QPair<QByteArray, QByteArray> > adaptiveEchoTokens(void);
86  static QPair<quint64, quint64> s_totalNeighborsBytesReadWritten;
87  static QPair<quint64, quint64> s_totalUiBytesReadWritten;
88  static QPointer<spoton_kernel> instance(void);
89  static QReadWriteLock s_totalNeighborsBytesReadWrittenMutex;
90  static QReadWriteLock s_totalUiBytesReadWrittenMutex;
91  static QVariant setting(const QString &name,
92  const QVariant &defaultValue);
93  static bool duplicateEmailRequests(const QByteArray &data);
94  static bool duplicateGeminis(const QByteArray &data);
95  static bool messagingCacheContains(const QByteArray &data,
96  const bool do_not_hash = false);
97  static int buzzKeyCount(void);
98  static int interfaces(void);
99  static void addBuzzKey(const QByteArray &key,
100  const QByteArray &channelType,
101  const QByteArray &hashKey,
102  const QByteArray &hashType);
103  static void clearBuzzKeysContainer(void);
104  static void discoverAdaptiveEchoPair
105  (const QByteArray &data,
106  QPair<QByteArray, QByteArray> &discoveredAdaptiveEchoPair);
107  static void emailRequestCacheAdd(const QByteArray &data);
108  static void geminisCacheAdd(const QByteArray &data);
109  static void messagingCacheAdd(const QByteArray &data,
110  const bool do_not_hash = false,
111  const int add_msecs = 0);
112  static void removeBuzzKey(const QByteArray &data);
113  bool acceptRemoteBluetoothConnection(const QString &localAddress,
114  const QString &peerAddress);
115  bool acceptRemoteConnection(const QHostAddress &localAddress,
116  const QHostAddress &peerAddress);
117  bool processPotentialStarBeamData
118  (const QByteArray &data,
119  QPair<QByteArray, QByteArray> &discoveredAdaptiveEchoPair);
120  void saveUrls(const QList<QByteArray> &urls);
121  void writeMessage0060(const QByteArray &data, int *neighborIndex, bool *ok);
122 
123  private:
124  QAtomicInt m_urlImportFutureInterrupt;
125  QDateTime m_lastPoptasticStatus;
126  QDateTime m_uptime;
127  QFileSystemWatcher m_settingsWatcher;
128  QFuture<void> m_checkForTerminationFuture;
129  QFuture<void> m_future;
130  QFuture<void> m_poptasticPopFuture;
131  QFuture<void> m_poptasticPostFuture;
132  QFuture<void> m_statisticsFuture;
133  QHash<QByteArray, QPair<QByteArray, QByteArray> > m_forwardSecrecyKeys;
134  QHash<qint64, QPointer<spoton_listener> > m_listeners;
135  QHash<qint64, QPointer<spoton_neighbor> > m_neighbors;
136  QHash<qint64, QPointer<spoton_starbeam_reader> > m_starbeamReaders;
137  QList<QByteArray> m_urlList;
138  QList<QHash<QString, QVariant> > m_poptasticAccounts;
139  QQueue<QHash<QString, QVariant> > m_poptasticCache;
140  QReadWriteLock m_poptasticCacheMutex;
141  QReadWriteLock m_forwardSecrecyKeysMutex;
142  QReadWriteLock m_urlListMutex;
143  QReadWriteLock m_urlsProcessedMutex;
144  QTimer m_controlDatabaseTimer;
145  QTimer m_impersonateTimer;
146  QTimer m_messagingCachePurgeTimer;
147  QTimer m_poptasticPopTimer;
148  QTimer m_poptasticPostTimer;
149  QTimer m_prepareTimer;
150  QTimer m_publishAllListenersPlaintextTimer;
151  QTimer m_scramblerTimer;
152  QTimer m_settingsTimer;
153  QTimer m_statusTimer;
154  QTimer m_urlImportTimer;
155  QVector<QFuture<void > > m_urlImportFutures;
156  int m_activeListeners;
157  int m_activeNeighbors;
158  int m_activeStarbeams;
159  quint64 m_urlsProcessed;
160  spoton_fireshare *m_fireShare;
161  spoton_gui_server *m_guiServer;
162  spoton_mailer *m_mailer;
163  spoton_starbeam_writer *m_starbeamWriter;
164  spoton_urldistribution *m_urlDistribution;
165  static QByteArray s_messagingCacheKey;
166  static QDateTime s_institutionLastModificationTime;
167  static QHash<QByteArray, QList<QByteArray> > s_buzzKeys;
168  static QHash<QByteArray, char> s_messagingCache;
169  static QHash<QByteArray, uint> s_emailRequestCache;
170  static QHash<QByteArray, uint> s_geminisCache;
171  static QHash<QString, QVariant> s_settings;
172  static QMultiMap<uint, QByteArray> s_messagingCacheLookup;
173  static QList<QList<QByteArray> > s_institutionKeys;
174  static QReadWriteLock s_adaptiveEchoPairsMutex;
175  static QReadWriteLock s_buzzKeysMutex;
176  static QReadWriteLock s_emailRequestCacheMutex;
177  static QReadWriteLock s_geminisCacheMutex;
178  static QReadWriteLock s_institutionKeysMutex;
179  static QReadWriteLock s_institutionLastModificationTimeMutex;
180  static QReadWriteLock s_messagingCacheMutex;
181  static QReadWriteLock s_settingsMutex;
182  bool initializeSecurityContainers(const QString &passphrase,
183  const QString &answer);
184  bool prepareAlmostAnonymousEmail(const QByteArray &attachmentData,
185  const QByteArray &fromAccount,
186  const QByteArray &goldbug,
187  const QByteArray &keyType,
188  const QByteArray &message,
189  const QByteArray &name,
190  const QByteArray &receiverName,
191  const QByteArray &subject,
192  const QByteArray &date,
193  const qint64 mailOid,
194  QByteArray &data);
195  void checkForTermination(void);
196  void cleanup(void);
197  void cleanupDatabases(void);
198  void cleanupListenersDatabase(const QSqlDatabase &db);
199  void cleanupNeighborsDatabase(const QSqlDatabase &db);
200  void cleanupStarbeamsDatabase(const QSqlDatabase &db);
201  void connectSignalsToNeighbor(QPointer<spoton_neighbor> neighbor);
202  void importUrls(void);
203  void popPoptastic(void);
204  void postPoptastic(void);
205  void postPoptasticMessage(const QByteArray &attachmentData,
206  const QByteArray &message,
207  const QByteArray &name,
208  const QByteArray &subject,
209  const QByteArray &mode,
210  const QByteArray &fromAccount,
211  const QByteArray &date,
212  const qint64 mailOid);
213  void postPoptasticMessage(const QString &receiverName,
214  const QByteArray &message);
215  void postPoptasticMessage(const QString &receiverName,
216  const QByteArray &message,
217  const QByteArray &fromAccount,
218  const qint64 mailOid);
219  void prepareListeners(void);
220  void prepareNeighbors(void);
221  void prepareStarbeamReaders(void);
222  void prepareStatus(const QString &keyType);
223  void purgeMessagingCache(void);
224  void saveGeminiPoptastic(const QByteArray &publicKeyHash,
225  const QByteArray &gemini,
226  const QByteArray &geminiHashKey,
227  const QByteArray &timestamp,
228  const QByteArray &signature,
229  const QString &messageType);
230  void updateStatistics(const QDateTime &uptime,
231  const QVector<int> &integers);
232 
233  private slots:
234  void slotBuzzMagnetReceivedFromUI(const qint64 oid,
235  const QByteArray &magnet);
236  void slotBuzzReceivedFromUI(const QByteArray &key,
237  const QByteArray &channelType,
238  const QByteArray &name,
239  const QByteArray &id,
240  const QByteArray &message,
241  const QByteArray &sendMethod,
242  const QString &messageType,
243  const QByteArray &hashKey,
244  const QByteArray &hashType,
245  const QByteArray &dateTime);
246  void slotCallParticipant(const QByteArray &publicKeyHash,
247  const QByteArray &gemini,
248  const QByteArray &geminiHashKey);
249  void slotCallParticipant(const QByteArray &keyType,
250  const qint64 oid);
251  void slotCallParticipantUsingForwardSecrecy(const QByteArray &keyType,
252  const qint64 oid);
253  void slotCallParticipantUsingGemini(const QByteArray &keyType,
254  const qint64 oid);
255  void slotDetachNeighbors(const qint64 listenerOid);
256  void slotDisconnectNeighbors(const qint64 listenerOid);
257  void slotForwardSecrecyInformationReceivedFromUI
258  (const QByteArrayList &list);
259  void slotForwardSecrecyResponseReceivedFromUI(const QByteArrayList &list);
260  void slotImpersonateTimeout(void);
261  void slotMessagingCachePurge(void);
262  void slotMessageReceivedFromUI(const qint64 oid,
263  const QByteArray &name,
264  const QByteArray &message,
265  const QByteArray &sequenceNumber,
266  const QByteArray &utcDate,
267  const QString &keyType);
268  void slotNewNeighbor(QPointer<spoton_neighbor> neighbor);
269  void slotPollDatabase(void);
270  void slotPoppedMessage(const QByteArray &message);
271  void slotPoptasticPop(void);
272  void slotPoptasticPost(void);
273  void slotPrepareObjects(void);
274  void slotPublicKeyReceivedFromUI(const qint64 oid,
275  const QByteArray &keyType,
276  const QByteArray &name,
277  const QByteArray &publicKey,
278  const QByteArray &signature,
279  const QByteArray &sPublicKey,
280  const QByteArray &sSignature,
281  const QString &messageType);
282  void slotPublicizeAllListenersPlaintext(void);
283  void slotPublicizeListenerPlaintext(const qint64 oid);
284  void slotPurgeEphemeralKeyPair(const QByteArray &publicKeyHash);
285  void slotPurgeEphemeralKeys(void);
286  void slotRequestScramble(void);
287  void slotRetrieveMail(void);
288  void slotSMPMessageReceivedFromUI(const QByteArrayList &list);
289  void slotSaveForwardSecrecySessionKeys(const QByteArrayList &list);
290  void slotScramble(void);
291  void slotSendMail(const QByteArray &goldbug,
292  const QByteArray &message,
293  const QByteArray &name,
294  const QByteArray &publicKey,
295  const QByteArray &subject,
296  const QByteArray &attachmentData,
297  const QByteArray &keyType,
298  const QByteArray &receiverName,
299  const QByteArray &mode,
300  const QByteArray &fromAccount,
301  const QByteArray &date,
302  const bool sign,
303  const qint64 mailOid);
304  void slotSettingsChanged(const QString &path);
305  void slotStatusTimerExpired(void);
306  void slotTerminate(const bool registered);
307  void slotUrlImportTimerExpired(void);
308  void slotUpdateSettings(void);
309 
310  signals:
311  void callParticipant(const QByteArray &data,
312  const QString &messageType);
313  void forwardSecrecyRequest(const QByteArrayList &list);
314  void forwardSecrecyResponseReceived(const QByteArrayList &list);
315  void newEMailArrived(void);
316  void poppedMessage(const QByteArray &message);
317  void publicizeListenerPlaintext(const QByteArray &data,
318  const qint64 id);
319 #if QT_VERSION >= 0x050501 && defined(SPOTON_BLUETOOTH_ENABLED)
320  void publicizeListenerPlaintext(const QBluetoothAddress &address,
321  const quint16 port,
322  const QString &orientation);
323 #endif
324  void publicizeListenerPlaintext(const QHostAddress &address,
325  const quint16 port,
326  const QString &transport,
327  const QString &orientation);
328  void receivedChatMessage(const QByteArray &data);
329  void retrieveMail(const QByteArrayList &list, const QString &messageType);
330  void sendBuzz(const QByteArray &buzz);
331  void sendForwardSecrecyPublicKey(const QByteArray &data);
332  void sendForwardSecrecySessionKeys(const QByteArray &data);
333  void sendMessage(const QByteArray &message,
334  const spoton_send::spoton_send_method sendMethod);
335  void sendMail(const QPairByteArrayInt64List &mail,
336  const QString &messageType);
337  void sendStatus(const QByteArrayList &status);
338  void smpMessage(const QByteArrayList &list);
339  void statusMessageReceived(const QByteArray &publicKeyHash,
340  const QString &status);
341  void terminate(const bool registered);
342  void write(const QByteArray &data, const qint64 id,
343  const QPairByteArrayByteArray &adaptiveEchoPair);
344 };
345 
346 #endif
Definition: spot-on-fireshare.h:36
Definition: spot-on-starbeam-reader.h:39
Definition: spot-on-mailer.h:38
Definition: spot-on-neighbor.h:180
Definition: spot-on-crypt.h:65
Definition: spot-on-urldistribution.h:34
Definition: spot-on-starbeam-writer.h:38
Definition: spot-on-kernel.h:69
Definition: spot-on-listener.h:167
Definition: spot-on-gui-server.h:82